Skip to content


ai  101  pytorch  classification  nvidia  cuda  install  tensorrt  yolo  ardupilot  None  ros2  dds  micro ros  xrce  sitl  plugin  SITL  debug  rangefinder  pymavlink  mavros  gazebo  distance sensor  system_time  timesync  cmake  gtest  ctest  cpp  c++  format  fmt  multithreading  spdlog  camera  coordinate system  orb  matching  opencv  build  transformation  computer vision  homography  optical flow  of  trackers  cv  cyclonedds  eprosima  fastdds  simulation  config  ignition  bridge  sdf  tips  ign-transport  sensors  lidar  aptly  apt  encryption  pgp  docker  git  bundle  github  hooks  pre-commit  lxd  container  lxc  x11  profile  vscode  marpit  presentation  marp  markdown  mermaid  video  ffmpeg  gstreamer  cheat-sheet  sdp  v4l2loopback  gi  snippets  cheat Sheet  python  asyncio  future  click  cli  numpy  project  template  black  isort  docs  project document  docstrings  flake8  linter  git-hook  mypy  unittest  pytest  pylint  mock  iterator  generator  logging  tuple  namedtuple  typing  annotation  pyzmq  zmq  msgpack  action  namespace  remap  control2  ros2_control  gdb  qos  tag  plugins  msg  node  zero-copy  shm  tutorial  algorithm  calibration  diff  pid  dev  colcon  colcon_cd  rpi  arm  qemu  settings  behavior  plot  visualization  debugging  diagnostic  diagnostics  tutorials  gst  math  apm  rat_runtime_monitor  web  rosbridge  vue  binding  discovery  gazebo-classic  launch  spawn  cook  gps  imu  ray  gazebo_ros_ray_sensor  ultrsonic  range  ultrasonic  gazebo classic  wrench  effort  odom  ign  gz  xacro  ros_ign  diff_drive  odometry  joint_state  argument  OpaqueFunction  DeclareLaunchArgument  LaunchConfiguration  tmux  nav  slam  test  rclpy  executor  MultiThreadedExecutor  SingleThreadedExecutor  param  dynamic-reconfigure  service  client  setup.py  package.xml  parameter  parameters  custom  msgs  executers  pub  sub  rqt  rviz  rviz2  pose  marker  tf2  deb  package  setup  local_setup  rosdep  package manager  project settings  vcstool  cross-compiler  nano  texture  tmuxp  rootfs  embedded  zah  linux  rm  ubuntu  ip  ss  network  netstat  snap  deploy  ssh  systemd  mkdocs  extensions  socat  networking  serial  udp  tc  mtu  select  px4  robotics  kalman_filter  kalman  filter  control  todo  vscode-ext  json  yaml  schema  yocto  poky  world  gazebo_ros2_control  position_controller  effort_controller  velocity_controller  urdf  gazebo_ros_force  gazebo_ros_joint_state_publisher  robot_state_publisher  joint_state_publisher  projects  vrx  buoyancy 

Python project template - unittest

tests using pytest


Table of Content

Install and Setup#

  • Add pytest to requirements-dev.txt
  • Run pip install -r requirements-dev.txt again
  • Create tests sub folder under root project folder
  • Add tests modules files prefix with test_
  • Add function to modules start also with test_ prefix
  • Install project using pip install -e .
  • Run pytest

demo#

demp_proj project

py_template/
├── .vscode
├── py_template
|    └── example.py
├── setup.cfg
├── setup.py
├── tests
|    └── test_example.py
├── venv
├── requirements.txt
├── requirements-dev.txt
└── version.py
test_example.py
# import pytest
# from py_template import example

# """
# # Run only tests mark as foo
# python -m pytest -m foo
# """
# @pytest.mark.foo
# def test_foo() -> None:
#     result = example.foo()
#     assert result is True

# @pytest.mark.foo
# def test_foo_with_assert_description() -> None:
#     result = example.foo()
#     assert result is True, "assert description"


# def test_bar() -> None:
#     result = example.bar(1)
#     assert result == 2.0


# def test_bar_with_exception() -> None:
#     with pytest.raises(ZeroDivisionError):
#         example.bar(0)

# def test_bar_with_exception_II() -> None:
#     """
#     catch general exception
#     check exception type with assert
#     """
#     with pytest.raises(Exception) as e:
#         example.bar(0)
#     assert e.type == ZeroDivisionError
example.py
from queue import Queue
import logging
import threading
import time
from collections import deque
from threading import Event
log = logging.getLogger(__name__)
logging.basicConfig(
    level=logging.INFO, format="[%(asctime)s] [%(name)s] %(levelname)s - %(message)s", datefmt='%H:%M:%S'
)
# some_queue: Queue = Queue(1)
some_queue: deque = deque(maxlen=1)
sync_event = Event()

def pub() -> None:
    counter = 0
    while True:
        try:
            some_queue.append(counter)
            sync_event.set()
            sync_event.clear()
            time.sleep(1 / 5)
            counter += 1
        except Exception:
            pass


def sub() -> None:
    while True:
        try:
            sync_event.wait()
            data = some_queue.popleft()
            # sync_event.clear()
            if data % 2:
                raise Exception("odd exception")
            log.info(data)
        except Exception:
            pass
            # log.warning("Exception handling", exc_info=True)
            # time.sleep(1)


if __name__ == "__main__":
    t1 = threading.Thread(target=pub)
    t2 = threading.Thread(target=sub)
    t1.start()
    t2.start()
    t1.join()
    t2.join()